home *** CD-ROM | disk | FTP | other *** search
/ Aminet 6 / Aminet 6 - June 1995.iso / Aminet / comm / tcp / GetMail.lha / GetMail.doc < prev   
Encoding:
Text File  |  1995-04-15  |  4.5 KB  |  151 lines
  1.  
  2. GetMail - Version 1.1
  3.  
  4.  
  5. INTRODUCTION:
  6.  
  7. GetMail is a POP Client, it is used for receiving mail to your
  8. local Amiga host from an Internet POP host.
  9.  
  10. GetMail was written with referance to the following mail RFC's.
  11. RFC-821, RFC-822, RFC-1081, RFC-1082, RFC-1225, RFC-1725.
  12.  
  13.  
  14. REQUIREMENTS:
  15.  
  16. Getmail requires WB 2.04 as a minimum (and will also utilise the
  17. file buffering of WB 3.0 where possible).
  18.  
  19. GetMail is for use with AmiTCP (it will not work with AS225), it
  20. was developed on version 4.0 of AmiTCP but I suspect that it will
  21. work on version 3.0 also.
  22.  
  23.  
  24. BACKGROUND:
  25.  
  26. When I signed up to get Internet access I keenly downloaded software
  27. from my local BBS and was immediately disapointed while reading the
  28. installation instructions.  It was quite clear that much of the
  29. software was ported from the Unix/UUCP environment as the software
  30. wanted a lot of assigns like UULib:, UUSpool: and many environmental
  31. variables.  Even worse, several software packages used the 
  32. environmental variables in conflicting mannors.  The Ported Unix
  33. code did not take full advantage to the Amiga OS and resulted in 
  34. large executable sizes.  I decided to write my own utilities.
  35.  
  36.  
  37. INSTALLATION:
  38.  
  39. I have provided both 68000 and 68020 executables.
  40.  
  41. Simply copy the GetMail executable (this is a dos command so no icon is
  42. required) to a library somewhere in your path.  A good place for it is
  43. in the AmiTCP:bin drawer.
  44.  
  45. I reccommend creating two environmental variables called EMAILADDR and
  46. POPHOST.  EMAILADDR is for your full E-Mail address (Also used by PutMail).
  47. POPHOST is for the host name of the POP Host that holds your E-Mail mailbox.
  48. These assigns are not manditory but they do reduce the arguments that
  49. you need to pass to GetMail.
  50.  
  51. Thats all (GetMail does obtain other details required for correct
  52. operation directly from AmiTCP), provided AmiTCP is up and running
  53. you can use GetMail immediately.
  54.  
  55.  
  56. OVERVIEW:
  57.  
  58. GetMail receives mail to the local AmiTCP user's HOME directory.
  59. The local file is "From " delimited (same as AmiPOP).
  60.  
  61.  
  62. USAGE:
  63.  
  64. The command template for GetMail is "GetMail MAIL=MAILFILE/K,
  65. USER/K,PASS=PASSWORD/A,EMAILADDR/K,POPHOST/K,DELETE/S,VERBOSE/S".
  66.  
  67.  
  68. Lets go through the arguments one by one.
  69.  
  70.  
  71. MAIL=MAILFILE     Optional argument.
  72.  
  73. This is the name of your local mail message file in your HOME
  74. directory where messages are to be stored.  It must be file name
  75. with no device name as GetMail appends this name to your home
  76. path.  If the file does not exist it will be created.  If it does
  77. exist the mail will be appended to it.  The default name is "Mail.InWard".
  78. The argument can be specified as MAILFILE=foo or abreviated as MAIL=foo.
  79.  
  80.  
  81. USER              Optional argument.
  82.  
  83. This is the UserID you use to access the POP Host.  If you don't
  84. provide this argument your local AmiTCP UserID will be used.
  85.  
  86.  
  87. PASS=PASSWORD     Manditory argument.
  88.  
  89. This is the password you use to access the POP Host.
  90.  
  91.  
  92. EMAIL=EMAILADDR   Optional argument.
  93.  
  94. This is your full E-Mail address.  If this argument is not supplied
  95. GetMail will use the environmental variable EMAILADDR, if that doesn't
  96. exist it will use your local AmiTCP UserID and the name of the host that
  97. you are connected to (obtained from the domain part of the local host name).
  98.  
  99.  
  100. POPHOST           Optional argument.
  101.  
  102. This is the name of the POP host that holds your E-Mail mailbox.
  103. If this argument is not supplied GetMail will use the environmental
  104. variable POPHOST, if that doesn't exist it will use the name of the
  105. host that you are connected to (obtained from the domain part of the
  106. local host name).
  107.  
  108.  
  109. DELETE            Optional argument.
  110.  
  111. This argument switches on deletion of messages read from the mailbox.
  112.  
  113.  
  114. VERBOSE           Optional argument.
  115.  
  116. This argument simply switches on verbose reporting of the program's
  117. activities and progress.  If you have problems using GetMail this may
  118. help explain why it's not working.  You can always redirect the verbose
  119. output to a file and post this to be if you need assistance.
  120.  
  121.  
  122. DEVELOPMENT:
  123.  
  124. GetMail was developed on an Amiga 3000 running WB 3.1 using SAS/C 6.51.
  125.  
  126.  
  127. SO LONG AND THANKS FOR THE FISH:
  128.  
  129. I hope you find GetMail easy to use and usefull.
  130.  
  131. Bug reports, Comments, ideas, *POSTCARDS*, E-Mail, gifts and requests
  132. for new utilities all welcome.
  133.  
  134. -------------------------------------------------------------------------
  135.  
  136. This program is freeware, use and/or distribute as you wish
  137. on a "NON Profit" basis.
  138.  
  139. No warranty exists, use this software at your own risk.
  140.  
  141. Martin V Lanza
  142. PO Box 8344,
  143. Christchurch,
  144. New Zealand.
  145.  
  146. mlanza@southern.co.nz
  147.  
  148. Home Phone 64-3-366-1618
  149.  
  150. (Amiga Fidonet echo areas also monitored)
  151.